/*
 *    Copyright 2009-2021 the original author or authors.
 *
 *    Licensed under the Apache License, Version 2.0 (the "License");
 *    you may not use this file except in compliance with the License.
 *    You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 *    Unless required by applicable law or agreed to in writing, software
 *    distributed under the License is distributed on an "AS IS" BASIS,
 *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *    See the License for the specific language governing permissions and
 *    limitations under the License.
 */
package org.apache.ibatis.reflection.wrapper;

import java.util.List;

import org.apache.ibatis.reflection.MetaObject;
import org.apache.ibatis.reflection.factory.ObjectFactory;
import org.apache.ibatis.reflection.property.PropertyTokenizer;

/**
 * 对象包装器接口
 *
 * @author Clinton Begin
 */
public interface ObjectWrapper {

  Object get(PropertyTokenizer prop);

  /**
   * 设置值
   *
   * @author evan Date : 2021/10/12
   */
  void set(PropertyTokenizer prop, Object value);

  String findProperty(String name, boolean useCamelCaseMapping);

  String[] getGetterNames();

  String[] getSetterNames();

  Class<?> getSetterType(String name);

  /**
   * 根据属性名获取 getter 方法的返回类型
   *
   * @param name 属性名
   * @return 返回类型
   * @author evan Date : 2021/10/11
   */
  Class<?> getGetterType(String name);

  /**
   * 是否有 setter 方法
   * 查询该属性名是否有 setter 方法
   *
   * @param name 属性名
   * @return true 有 setter 方法
   * @author evan Date : 2021/10/12
   */
  boolean hasSetter(String name);

  boolean hasGetter(String name);

  /**
   * 创建指定属性的值
   *
   * @param name          属性名
   * @param prop          分词器
   * @param objectFactory 对象工程
   * @return 元对象
   * @author evan Date : 2021/10/12
   */
  MetaObject instantiatePropertyValue(String name, PropertyTokenizer prop, ObjectFactory objectFactory);

  /**
   * 是否为集合
   *
   * @author evan Date : 2021/10/11
   */
  boolean isCollection();

  /**
   * 添加集合
   *
   * @author evan Date : 2021/10/11
   */
  void add(Object element);

  /**
   * 批量添加集合
   *
   * @author evan Date : 2021/10/11
   */
  <E> void addAll(List<E> element);

}
